/*
 * Copyright 2002-2012 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.jmx.export.metadata;

import java.lang.reflect.Method;

import org.springframework.lang.Nullable;

/**
 * Interface used by the {@code MetadataMBeanInfoAssembler} to
 * read source-level metadata from a managed resource's class.
 *
 * @author Rob Harrop
 * @author Jennifer Hickey
 * @see org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler#setAttributeSource
 * @see org.springframework.jmx.export.MBeanExporter#setAssembler
 * @since 1.2
 */
public interface JmxAttributeSource {

    /**
     * Implementations should return an instance of {@code ManagedResource}
     * if the supplied {@code Class} has the appropriate metadata.
     * Otherwise should return {@code null}.
     *
     * @param clazz the class to read the attribute data from
     * @return the attribute, or {@code null} if not found
     * @throws InvalidMetadataException in case of invalid attributes
     */
    @Nullable
    ManagedResource getManagedResource(Class<?> clazz) throws InvalidMetadataException;

    /**
     * Implementations should return an instance of {@code ManagedAttribute}
     * if the supplied {@code Method} has the corresponding metadata.
     * Otherwise should return {@code null}.
     *
     * @param method the method to read the attribute data from
     * @return the attribute, or {@code null} if not found
     * @throws InvalidMetadataException in case of invalid attributes
     */
    @Nullable
    ManagedAttribute getManagedAttribute(Method method) throws InvalidMetadataException;

    /**
     * Implementations should return an instance of {@code ManagedMetric}
     * if the supplied {@code Method} has the corresponding metadata.
     * Otherwise should return {@code null}.
     *
     * @param method the method to read the attribute data from
     * @return the metric, or {@code null} if not found
     * @throws InvalidMetadataException in case of invalid attributes
     */
    @Nullable
    ManagedMetric getManagedMetric(Method method) throws InvalidMetadataException;

    /**
     * Implementations should return an instance of {@code ManagedOperation}
     * if the supplied {@code Method} has the corresponding metadata.
     * Otherwise should return {@code null}.
     *
     * @param method the method to read the attribute data from
     * @return the attribute, or {@code null} if not found
     * @throws InvalidMetadataException in case of invalid attributes
     */
    @Nullable
    ManagedOperation getManagedOperation(Method method) throws InvalidMetadataException;

    /**
     * Implementations should return an array of {@code ManagedOperationParameter}
     * if the supplied {@code Method} has the corresponding metadata. Otherwise
     * should return an empty array if no metadata is found.
     *
     * @param method the {@code Method} to read the metadata from
     * @return the parameter information.
     * @throws InvalidMetadataException in the case of invalid attributes.
     */
    ManagedOperationParameter[] getManagedOperationParameters(Method method) throws InvalidMetadataException;

    /**
     * Implementations should return an array of {@link ManagedNotification ManagedNotifications}
     * if the supplied the {@code Class} has the corresponding metadata. Otherwise
     * should return an empty array.
     *
     * @param clazz the {@code Class} to read the metadata from
     * @return the notification information
     * @throws InvalidMetadataException in the case of invalid metadata
     */
    ManagedNotification[] getManagedNotifications(Class<?> clazz) throws InvalidMetadataException;


}
